7.4 查询应用详情(支持根据name查询)
Path: /api/v1/resource/queryResource
Method: GET
请求参数
Query
注意: 1. 各个样例之间为并列关系, 实际发送请求时只需参照其中某一个即可
根据id查询
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 必须 | 应用ID |
根据name查询
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
name | 必须 | 应用名 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 返回码,0代表成功 | ||
data | object | 必须 | 返回内容 | ||
├─ id | string | 必须 | 应用ID | ||
├─├─addressList | object[] | 必须 | 应用地址列表(仅隧道应用) | ||
├─├─├─ protocol | string | 非必须 | 协议 | tcp/udp/icmp/all | |
├─├─├─ host | string | 非必须 | 服务器地址 | ||
├─├─├─ port | string | 非必须 | 端口 | ||
├─ appAddress | string | 必须 | 应用地址(仅WEB应用) | ||
├─ accessAddressConfig | object [] | 必须 | 前端地址高级配置 | ||
├─├─ aliasList | string [] | 必须 | 别名列表 | ||
├─├─ actionList | string [] | 必须 | 前端地址别名执行操作列表 | ||
├─accessModel | string | 必须 | 访问模式 WEB/L3VPN/TP-WEB | ||
├─aliasAppAddress | string | 必须 | 应用地址别名,仅web | ||
├─accessAddress | string | 必须 | 访问地址 | ||
├─applyForInfo | object | 必须 | 用户申请信息 | ||
├─├─ content | string | 必须 | 告警内容 | ||
├─├─ accessReason | string [] | 必须 | 申请理由 | ||
├─ description | string | 非必须 | 描述 | ||
├─ groupId | string | 必须 | 所属应用分类ID | ||
├─ groupName | string | 必须 | 所属应用分类名称 | ||
├─ iconId | string | 必须 | 图标 | ||
├─ iconType | string | 必须 | 图标类型,只能属于['font', 'upload', 'capture']其一的值 | ||
├─ iconPath | string | 必须 | 图标路径名。如果类型为capture,则为抓取的url列表 | ||
├─ level | string | 必须 | 保密级别 | ||
├─ status | number | 必须 | 启用状态,0:禁用;1:启用 | ||
├─ baselineStatus | number | 必须 | 基线状态 | ||
├─ name | string | 必须 | 名字 | ||
├─ nodeGroupId | string | 必须 | 应用所属节点区域id | ||
├─ nodeGroupAddr | object | 必须 | 应用所属节点区域地址信息 | ||
├─ ├─ lan | string[] | 必须 | 节点区域LAN地址列表 | ||
├─ ├─ wan | string[] | 必须 | 节点区域WAN地址列表 | ||
├─ trustedCertId | string | 必须 | 授信证书id,仅web,TP-WEB | ||
├─ trustedCertName | string | 必须 | 授信证书名称,仅web,TP-WEB | ||
├─ protocol | string | 必须 | 协议,l3vpn | ||
├─ protocolType | string | 必须 | 协议类型 | ||
├─ ext | object | 非必须 | 扩展字段 | ||
├─ ├─ paths | string [] | 必须 | 黑白名单 | ||
├─ ├─ disableAccessAddressListen | number | 必须 | 前端地址是否只改写不监听(仅WEB应用) | ||
├─ ├─ reqRewriteAddress | string | 必须 | 后端地址高级配置自定义请求头(仅WEB应用) | ||
├─ ├─ pathStatus | number | 必须 | 名单状态 | ||
├─ ├─ ipStatus | number | 必须 | 限制ip状态 | ||
├─ ├─ allowIps | string [] | 必须 | 限制ip列表 | ||
├─├─ dependSites | object | 必须 | 依赖站点配置 | ||
├─├─ ├─ enable | number | 必须 | 依赖站点开关 | ||
├─├─ ├─ panDomain | string | 必须 | 泛域名 | ||
├─├─ ├─ siteList | object [] | 必须 | 依赖站点 | ||
├─├─ ├─ ├─ appAddress | string | 必须 | 后端地址 | ||
├─├─ ├─ ├─ accessAddress | string | 必须 | 前端访问地址 | ||
├─├─ security | object | 必须 | 应用安全配置 | ||
├─├─ ├─ watermark | object | 必须 | 水印配置 | ||
├─├─ ├─ ├─ enable | number | 必须 | 开关 | ||
├─├─ ├─ netZone | object | 必须 | 网络区域限制 | ||
├─├─ ├─ ├─enable | string | 必须 | 0 表示关闭区域限制,1表示开启区域限制(限制为ids里面的区域) | ||
├─├─ ├─ ├─ ids | string [] | 必须 | 网络区域id | ||
├─├─ openModel | object | 必须 | 打开方式 | ||
├─├─├─ model | string | 必须 | 方式 | ||
├─├─├─ programName | string | 必须 | 程序名称 | ||
├─├─├─ processName | string | 必须 | 进程名 | ||
├─├─├─ issuerName | array | 必须 | 签名者名称 | ||
├─├─├─ originalFilename | string | 必须 | 原始文件名 | ||
├─├─├─ useDefaultBrowser | string | 必须 | 允许在未找到该浏览器时自动打开默认浏览器 | ||
├─ ssoConfig | object | 必须 | 单点登录配置,无需关注 | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": {
"data": [{
"id": "731f0870-24bb-11eb-ad72-ef52c7216cc3",
"status": 1,
"accessModel": "WEB",
"name": "协同文档",
"description": "",
"groupId": "128a0550-23da-11eb-9d89-2930adc4c963",
"groupName": "公司模拟依赖站点",
"appAddress": "https://www.test.com",
"accessAddress": "https://www.test.com",
"trustedCertId": "dd79210e-1ab1-4665-98c8-849abc7ab8e0",
"trustedCertName": "sf.com",
"protocol": "",
"nodeGroupId": "39e49780-ee53-11ea-a15f-5d6b64c8ca53",
"iconId": "1",
"level": "3",
"ext": {
"paths": [],
"readXFF": 0,
"allowIps": [],
"dnsProxy": {
"enable": 0,
"enableLan": 0,
"enableWan": 0
},
"ipStatus": 0,
"pathType": 1,
"security": {
"netZone": {
"enable": 0,
"ids": []
},
"watermark": {
"enable": 0
}
},
"pathStatus": 0,
"dependSites": {
"enable": 1,
"panDomain": "sangfor.com",
"isPanDomainCert": true,
"siteList": [{
"appAddress": "http://192.168.1.3:8060",
"accessAddress": "https://192-168-1-3-8060-p.sangfor.com:443"
}]
},
"enableTransparentProxy": 0,
"disableAccessAddressListen": 0,
"openModel": {
"model": "default-browser",
"originalFilename": "",
"processName": "",
"programDownloadUrl": "",
"programName": "",
"issuerName": [],
"useDefaultBrowser": 1
}
},
"accessProtocol": "https:",
"accessHostname": "www.test.com",
"accessPort": 443,
"iconPath": "",
"iconType": "font",
"creator": "admin",
"creatorRole": "超级管理员",
"baselineStatus": 0,
"applyForInfo": {
"content": "您没有权限访问该应用,如需访问须提交访问申请\n若申请长时间未处理,请联系管理员:\n联系人:张三(工号10001)\n联系电话:187xxxxxx1x",
"accessReason": ["我所属组织架构均需要通过此应用开展业务工作", "我因为岗位职责原因需要访问该应用", "我因为个人特殊原因需要访问该应用"]
},
"nodeGroupAddr": {
"lan": ["10.242.3.231"],
"wan": ["10.10.3.224"]
},
"accessAddressConfig": [{
"actionList": ["redirect", "listen"]
}, {
"actionList": ["listen"]
}],
"ssoConfig": {
"enable": false
},
"aliasAppAddresses": "",
"ssoConfigDemo": {
"enable": true,
"url": "http://idtrust.com:100/login",
"mode": "intelligent",
"intelligent": {
"autoCommit": true,
"username": {
"type": "user.username"
}
},
"advanced": {
"widgetConfig": [{
"id": "username",
"name": "账号输入框",
"widgetType": "username",
"match": {
"type": "auto",
"value": "account"
},
"value": {
"type": "user.username",
"value": ""
}
}, {
"id": "password",
"name": "密码输入框",
"widgetType": "password",
"match": {
"type": "auto",
"value": "password"
},
"value": {
"type": "user.password",
"value": ""
}
}, {
"id": "login",
"name": "登录按钮",
"widgetType": "login",
"match": {
"type": "auto",
"value": "login"
}
}, {
"id": "一个UUID",
"name": "区域选择",
"widgetType": "text",
"match": {
"type": "auto",
"value": "path"
},
"value": {
"type": "user.groupPath",
"value": ""
}
}, {
"id": "一个UUID",
"name": "脚本示例",
"widgetType": "text",
"match": {
"value": "function(){}"
}
}]
}
}
}]
},
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |
数据可能存在异常 | 10000001 |
the appAddress is invalid | 10000001 |
应用不存在 | 77200001 |